<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdauiBar: GdaBrowser hacking manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GdaBrowser hacking manual">
<link rel="up" href="extrawidgets.html" title="Extra widgets">
<link rel="prev" href="gda-browser-UiFormgrid.html" title="UiFormgrid">
<link rel="next" href="gda-browser-popup-container.html" title="PopupContainer">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gda-browser-gdaui-bar.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gda-browser-gdaui-bar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#gda-browser-gdaui-bar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gda-browser-gdaui-bar.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="extrawidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gda-browser-UiFormgrid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gda-browser-popup-container.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gda-browser-gdaui-bar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gda-browser-gdaui-bar.top_of_page"></a>GdauiBar</span></h2>
<p>GdauiBar</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-new" title="gdaui_bar_new ()">gdaui_bar_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-get-text" title="gdaui_bar_get_text ()">gdaui_bar_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-set-text" title="gdaui_bar_set_text ()">gdaui_bar_set_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-set-icon-from-pixbuf" title="gdaui_bar_set_icon_from_pixbuf ()">gdaui_bar_set_icon_from_pixbuf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-set-icon-from-file" title="gdaui_bar_set_icon_from_file ()">gdaui_bar_set_icon_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-set-icon-from-stock" title="gdaui_bar_set_icon_from_stock ()">gdaui_bar_set_icon_from_stock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-set-show-icon" title="gdaui_bar_set_show_icon ()">gdaui_bar_set_show_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gda-browser-gdaui-bar.html#gdaui-bar-get-show-icon" title="gdaui_bar_get_show_icon ()">gdaui_bar_get_show_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar--show-icon" title="The “show-icon” property">show-icon</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar--text" title="The “text” property">text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GdauiBar"></a><div class="refsect1">
<a name="gda-browser-gdaui-bar.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gda-browser-gdaui-bar.html#GdauiBarPrivate" title="GdauiBarPrivate">GdauiBarPrivate</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar-struct" title="struct GdauiBar">GdauiBar</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html#GtkBox-struct">GtkBox</a>
                    <span class="lineart">╰──</span> GdauiBar
</pre>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdauiBar implements
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and  <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdaui-bar-new"></a><h3>gdaui_bar_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gdaui_bar_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>Creates a new <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> object.</p>
<div class="refsect3">
<a name="gdaui-bar-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-get-text"></a><h3>gdaui_bar_get_text ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdaui_bar_get_text (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>);</pre>
<p>Get the text being displayed in the given gray bar widget. This
does not include any embedded underlines indicating mnemonics or
Pango markup.</p>
<div class="refsect3">
<a name="gdaui-bar-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> widget.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-bar-get-text.returns"></a><h4>Returns</h4>
<p> the text in the widget.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-set-text"></a><h3>gdaui_bar_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_bar_set_text (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>,
                    <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>Set the text displayed in the given gray bar widget. This can include
embedded underlines indicating mnemonics or Pango markup.</p>
<div class="refsect3">
<a name="gdaui-bar-set-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>a string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-set-icon-from-pixbuf"></a><h3>gdaui_bar_set_icon_from_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_bar_set_icon_from_pixbuf (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-set-icon-from-file"></a><h3>gdaui_bar_set_icon_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_bar_set_icon_from_file (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>,
                              <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-set-icon-from-stock"></a><h3>gdaui_bar_set_icon_from_stock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_bar_set_icon_from_stock (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                               <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/gtk3-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> size</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-set-show-icon"></a><h3>gdaui_bar_set_show_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_bar_set_show_icon (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>,
                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);</pre>
<p>Set the icon displaying mode for the given grid.</p>
<div class="refsect3">
<a name="gdaui-bar-set-show-icon.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show</p></td>
<td class="parameter_description"><p>whether to show the icon or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-bar-get-show-icon"></a><h3>gdaui_bar_get_show_icon ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdaui_bar_get_show_icon (<em class="parameter"><code><a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> *bar</code></em>);</pre>
<p>Get whether the icon is being shown for the given gray bar.</p>
<div class="refsect3">
<a name="gdaui-bar-get-show-icon.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>bar</p></td>
<td class="parameter_description"><p>a <a class="link" href="gda-browser-gdaui-bar.html#GdauiBar"><span class="type">GdauiBar</span></a> widget.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-bar-get-show-icon.returns"></a><h4>Returns</h4>
<p> TRUE if the icon is shown, FALSE if not.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdauiBarPrivate"></a><h3>GdauiBarPrivate</h3>
<pre class="programlisting">typedef struct _GdauiBarPrivate GdauiBarPrivate;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBar-struct"></a><h3>struct GdauiBar</h3>
<pre class="programlisting">struct GdauiBar;</pre>
</div>
</div>
<div class="refsect1">
<a name="gda-browser-gdaui-bar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdauiBar--show-icon"></a><h3>The <code class="literal">“show-icon”</code> property</h3>
<pre class="programlisting">  “show-icon”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Owner: GdauiBar</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBar--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting">  “text”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Text showed inside the widget.</p>
<p>Owner: GdauiBar</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>